Apply Theme To Items

Apply Theme To Items.

Method

/API3/themes/applyTheme

  • API Section: /API3/themes
  • API Version: 3.0
  • From Release: 2023.10
  • Usage: REST API and Client SDK libraries. REST APIs via POST actions only.
  • Usage by:
    • Enterprise Admin
    • Domain Admin

Method Signature

Input Parameters

Name

themeToItemsObject

Object Type

ThemeToItemsApiObject

Description

An object containing theme id and the item ids that should contain this theme.

Output Response

Successful Result Code

200

Response Type

ModifiedItemsResult

Description of Response Type

Generic API response object with success or failure flag and related messages.

Code Snippets

Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.

TypeScript
Curl
Java
C#
Python
PHP
curl -X POST \
-H "paToken: [[apiKey]]" \
 -H "Accept: application/json,application/json;charset=utf-8,text/plain,text/plain;charset=utf-8" \
 -H "Content-Type: application/json" \
 "http://Your.Server.URL/API3/themes/applyTheme" \
 -d '{
  "themeId" : "themeId",
  "itemIdsList" : [ "itemIdsList", "itemIdsList" ]
}'

import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.ThemesServiceApi;

import java.util.*;
import java.time.*;

public class ThemesServiceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://Your.Server.URL/");
        
        // Configure API key authorization: paToken
        ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
        paToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //paToken.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ThemesServiceApi apiInstance = new ThemesServiceApi();
        // Initialize the themeToItemsObject parameter object for the call
        ThemeToItemsApiObject themeToItemsObject = ; // Create the input object for the operation, type: ThemeToItemsApiObject 

        try {
            ModifiedItemsResult result = apiInstance.applyTheme(themeToItemsObject);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ThemesServiceApi#applyTheme");
            e.printStackTrace();
        }
    }
}

import * as PyramidAnalyticsWebApi from "com.pyramidanalytics";

// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.ThemesServiceApi("http://Your.Server.URL")

// Configure API key authorization: paToken
api.setApiToken("YOUR API KEY");

const themeToItemsObject = ; // {ThemeToItemsApiObject} 

api.applyTheme(themeToItemsObject).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});


using System;
using System.Diagnostics;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;

public class applyThemeExample
{
    public static void Main()
    {
        Configuration conf = new Configuration();
        conf.BasePath = "http://Your.Server.URL/";
        
        
        // Configure API key authorization: paToken
        conf.ApiKey.Add("paToken", "YOUR_API_KEY");
        // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
        // conf.ApiKeyPrefix.Add("paToken", "Bearer");

        GlobalConfiguration.Instance = conf;
        
        // Create an instance of the API class
        var apiInstance = new ThemesServiceApi();
        // Initialize the themeToItemsObject parameter object for the call
        var themeToItemsObject = new ThemeToItemsApiObject(); // ThemeToItemsApiObject | 

        try {
            // Apply Theme To Items.
            ModifiedItemsResult result = apiInstance.applyTheme(themeToItemsObject);
            Debug.WriteLine(result);
        } catch (Exception e) {
            Debug.Print("Exception when calling ThemesServiceApi.applyTheme: " + e.Message );
        }
    }
}


import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from com.pyramidanalytics import ThemesServiceApi
from pprint import pprint

        
# Configure API key authorization: paToken
api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })

with com.pyramidanalytics.ApiClient(api_config) as api_client:
    # Create an instance of the API class
    api_instance = ThemesServiceApi(api_client)
    # Initialize the themeToItemsObject parameter object for the call
    themeToItemsObject =  # ThemeToItemsApiObject | 

    try:
        # Apply Theme To Items.
        api_response = api_instance.apply_theme(themeToItemsObject)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ThemesServiceApi->applyTheme: %s\n" % e)
<?php
require_once(__DIR__ . '/vendor/autoload.php');

OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');

// Configure API key authorization: paToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ThemesServiceApi();
$themeToItemsObject = ; // ThemeToItemsApiObject | 

try {
    $result = $api_instance->applyTheme($themeToItemsObject);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ThemesServiceApi->applyTheme: ', $e->getMessage(), PHP_EOL;
}
?>